Users
A person that other records refer to: authors, owners, members, assignees and people with access. Inside the package a user is identified by external_id; in the target company the person is matched by email. A person who is not in the company yet is added to it without an invitation email, and a new account stays not activated until the person signs in. Write each person once and use a real, unique email.
Files in the package
List every file of this entity in resource_files of the manifest, with "resource": "users". An entity can have any number of files. See Bundle format.
[
{
"resource": "users",
"path": "resources/users.json"
}
]Fields
| Field | Type | Required | Description |
|---|---|---|---|
external_id | string (ExternalId) | Yes | Your own identifier of the record, for example k-mrr, unique within the resource across all of its files and case sensitive. Other records refer to this one by it.Constraints: 1–512 characters. |
email | string | Yes | The person's email address, for example ava.reyes@example.com. It is converted to lower case and is how the person is matched in the target company.Constraints: 3–128 characters; format email. Rule: Unique without regard to case. |
full_name | string? | No | The person's full name, for example Ava Reyes. |
References
Referenced by
- Activities:
author_ref,payload.user_ref - Attachments:
author_ref - Card history:
snapshot.owner_ref - Card members:
user_ref - Card time logs:
author_ref,user_ref - Card types:
author_ref - Cards:
owner_ref,properties,subscriber_refs,updated_by_ref - Checklist items:
author_ref,checker_ref,responsible_ref - Comments:
author_ref,emojis[].user_ref - Custom directories:
author_ref - Custom directory records:
author_ref,values - Custom properties:
author_ref - Document comments:
author_ref - Documents:
author_ref,updated_by_ref - Folders:
author_ref - Iteration cards:
added_by_ref - Iterations:
author_ref,updated_by_ref - Spaces:
author_ref - Tree entity roles:
member_ref - User groups:
admin_refs,user_refs
Show on the entity map
Example
A record of this entity:
{
"external_id": "u-ava",
"email": "ava.reyes@example.com",
"full_name": "Ava Reyes"
}Rules
- The value of email must be unique without regard to case.
Related entities
Card members, Comments, Tree entity roles
Check after the import
After the import, the records of this entity can be checked on Users › Retrieve list of users.
JSON Schema
users.json
