Get actors schema

Get an actor schema via API

You can get actors schema¹ belonging to a specific project in Tallyfy Manufactory² using the endpoint GET /actors/schema/{org_id}/{project_id}.

Authentication

The following header is required for all API calls:

• X-Manufactory-Auth - Manufactory access token

Required values

• org_id (required) string - Manufactory org ID.
• project_id (required) number - Manufactory project ID.

Response example

{
  "attributes": [
    {
      "name": "city",
      "display_name": "City",
      "data_type": "text"
    },
    {
      "name": "country",
      "display_name": "Country",
      "data_type": "text"
    },
    {
      "name": "email",
      "display_name": "Email",
      "data_type": "text"
    },
    {
      "name": "username",
      "display_name": "Username",
      "data_type": "text"
    }
  ],
  "org_id": "xyz",
  "unique_id": "email",
  "project_id": 12345
}

Related articles

Actors > Delete actors schema

The DELETE /actors/schema endpoint allows removal of actor schemas from Tallyfy Manufactory by providing organization ID project ID and authentication token.

Actors > Create actors schema

The POST /actors/schema endpoint enables creation of user schemas in Tallyfy Manufactory by specifying organization ID project ID attribute definitions and a unique identifier field with proper authentication headers.

Events > Get events schema

The GET endpoint retrieves event schema attributes like event name type and purchase status for a specific project within an organization using Manufactory access token authentication.

Manufactory > Actors

Designing actor schemas in Tallyfy Manufactory requires careful planning of user properties to ensure successful project implementation.

Footnotes

1. Data structure defining the attributes and properties of workflow participants in a project ↩

2. Tallyfy’s manufacturing workflow automation platform with custom data structures and actors ↩

Was this helpful?

YesNo