Get actors schema

Get an actor schema via API

Section titled “Get an actor schema via API”

Here’s how to get an actor schema¹ for a specific project in Tallyfy Manufactory². Use the endpoint GET /actors/schema/{org_id}/{project_id}.

Authentication

Section titled “Authentication”

You’ll need this header for all API calls:

• X-Manufactory-Auth - Manufactory access token

Required values

Section titled “Required values”

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

Response example

Section titled “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

Section titled “Related articles”

Actors > Create actors schema

The POST /actors/schema endpoint lets you create user schemas in Tallyfy Manufactory by…

Actors > Delete actor schema

Remove an actor schema from Tallyfy Manufactory with the DELETE /actors/schema endpoint. You’ll…

Events > Get events schema

Retrieve event schema attributes like event name, type, and purchase status for a specific…

Manufactory > Actors

Actors represent users in Tallyfy Manufactory projects. Design and build actor schemas by…

Footnotes

Section titled “Footnotes”

1. It’s a 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