API Reference
Scalars
Roles
Common objects
Slots
Projects
Services
Bookings
Spaces
Locations
Assets
Team
Reviews
Reminders
Webhooks
Denylist
Schema
JS SDK
Timerise © 2022
Team overview
The team is a list of all users added via API Timerise. Each user has a specific role. The user can be a person who works with the API (developer) or a service host, e.g. a doctor.
Queries
team
Returns a list of team members.
team(
projectId: ID!
limit: NonNegativeInt
cursor: ID
): [User]| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
limit | NonNegativeInt | false | |
cursor | ID | false | A globally-unique identifier. |
Minimal role required:
MANAGERteamMember
Returns a team member.
teamMember(
projectId: ID!
userId: ID!
): User| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
userId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERMutations
teamMemberCreate
Creates a team member.
teamMemberCreate(
projectId: ID!
userId: ID!
role: UserRole!
fullName: NonEmptyString
jobTitle: NonEmptyString
phoneNumber: PhoneNumber
photoUrl: URL
): User| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
userId | ID | true | |
role | UserRole | true | |
fullName | NonEmptyString | false | |
jobTitle | NonEmptyString | false | |
phoneNumber | phoneNumber | false | |
photoUrl | URL | false |
Minimal role required:
MANAGERteamMemberUpdate
Updates a team member.
teamMemberUpdate(
projectId: ID!
userId: ID!
role: UserRole
fullName: NonEmptyString
jobTitle: NonEmptyString
phoneNumber: PhoneNumber
photoUrl: URL
): User| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
userId | ID | true | |
role | UserRole | false | |
fullName | NonEmptyString | false | |
jobTitle | NonEmptyString | false | |
phoneNumber | phoneNumber | false | |
photoUrl | URL | false |
Minimal role required:
MANAGERteamMemberDelete
Removes a team member.
teamMemberDelete(
projectId: ID!
userId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
userId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERteamMemberInvite
Invite a new team member.
teamMemberInvite(
projectId: ID!
invitations: [TeamMemberInvitationInput!]!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
invitations | [TeamMemberInvitationInput] | true | A globally-unique identifier. |
Minimal role required:
MANAGERteamMemberInvitationAccept
Accept a invitation.
teamMemberInvitationAccept(
projectId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERteamMemberInvitationReject
Reject a invitation.
teamMemberInvitationReject(
projectId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGERteamMemberInvitationDelete
Removes a new team member invitation.
teamMemberInvitationDelete(
projectId: ID!
invitationId: ID!
): String| Field name | Value type | Required | Description |
|---|---|---|---|
projectId | ID | true | A globally-unique identifier. |
invitationId | ID | true | A globally-unique identifier. |
Minimal role required:
MANAGER