Team API | Genaya API Reference

Organization

Team

The organization's team members (roster). Read-only in v1.

GET/team

List team members

Returns a cursor-paginated list of the organization's team members (the roster). Team membership is managed inside the Genaya app and is read-only here - there is no create, update, or delete, and no created-date (from/to) filtering. Requires scope: team:read.

Response 200

No fields.

Errors

400Malformed or missing parameters

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/team \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "Qw8aB2cD3eF4gH5i",
      "object": "team_member",
      "name": "Jordan Rivera",
      "email": "jordan@example.com",
      "phone": "+15551234567",
      "role": "manager",
      "status": "active",
      "emailVerified": true,
      "createdAt": "2026-06-01T14:32:00.000Z",
      "color": "#2ecc71",
      "homeAddress": "480 Brickell Ave, Miami, FL 33131",
      "appointmentTypes": [
        "Af7xGILXKpsl3yWeoyoO",
        "Yv5nk9GNAXKNRLnfR2tN"
      ],
      "serviceAreas": [
        "vD2qumxBO9WkRJPUloI7"
      ],
      "companies": [
        "7Rk1pQm4Nx2LbV8c"
      ],
      "payroll": {
        "workerType": "employee",
        "payBasis": "hourly",
        "hourlyRate": 32.5,
        "annualSalary": null,
        "salaryPeriod": "yearly",
        "currency": "USD",
        "commission": 10,
        "commissionExcludesTaxAndFees": true,
        "commissionRule": null,
        "paySchedule": "weekly",
        "weekStartsOn": "monday",
        "timezone": "America/New_York",
        "allowBonuses": false,
        "overtime": {
          "enabled": true,
          "afterHoursPerWeek": 40,
          "multiplier": 1.5
        },
        "breaks": {
          "enabled": true,
          "paid": false,
          "autoDeductMinutes": 30,
          "afterHours": 6,
          "deductsFromShift": true
        },
        "deductions": {
          "enabled": true,
          "estimatedTaxPercent": 22,
          "items": [
            {
              "id": "ded_health",
              "label": "Health plan",
              "kind": "pre_tax",
              "mode": "amount",
              "value": 120
            }
          ]
        }
      }
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/team/{id}

Retrieve a team member

Returns a single team member by id. This resolves the member ids that appear elsewhere in the API - an appointment's assigned team, a commission's employeeId. A member of another organization returns 404 rather than 403. Requires scope: team:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

Unique identifier of the team member.

object

string

name

string

The member's display name.

email

string

The member's email address.

phone

string

The member's phone number, when set.

role

The member's role / permission level.

status

string

Membership status (e.g. active, inactive).

emailVerified

boolean

Whether the member has verified their email / accepted their invite.

createdAt

string <date-time>

When the member was added to the organization.nullable

color

string

Hex color swatch used for this member on the schedule.nullable

homeAddress

string

The member's home address as entered on their profile, when set.nullable

appointmentTypes

array of string

Ids of the appointment types this member is assigned to. Resolve them with GET /v1/appointment-types. Empty when the member is not restricted to specific types.

serviceAreas

array of string

Ids of the service areas this member covers. Empty when the member is not restricted to specific areas.

companies

array of string

Ids of the companies this member is assigned to. Resolve them with GET /v1/companies.

payroll

any

PayDesk pay settings for this member IN THE ORGANIZATION THE API KEY BELONGS TO. A member who works for more than one organization has a separate set of pay settings for each; only yours is ever returned. Null when no pay settings have been configured for the member. REQUIRES THE `paydesk:read` SCOPE IN ADDITION TO `team:read`. This block is compensation data, so for a key that carries only `team:read` (a roster grant) the property is OMITTED ENTIRELY rather than returned as null - null is reserved for "this member has no pay settings", so the two cases stay distinguishable. Add `paydesk:read` to the key in Settings > Developers to receive it.nullable

Errors

401Bad, missing, or revoked key

402The prepaid balance has nothing left for API requests past the included pool, or the trial requests are used up

403Lacks scope, plan without API access, live key on a trial, test key writing, or feature switched off

404No such resource in this organization

429Rate limited

500Unexpected server error

curl -X GET https://api.genaya.com/v1/team/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "Qw8aB2cD3eF4gH5i",
    "object": "team_member",
    "name": "Jordan Rivera",
    "email": "jordan@example.com",
    "phone": "+15551234567",
    "role": "manager",
    "status": "active",
    "emailVerified": true,
    "createdAt": "2026-06-01T14:32:00.000Z",
    "color": "#2ecc71",
    "homeAddress": "480 Brickell Ave, Miami, FL 33131",
    "appointmentTypes": [
      "Af7xGILXKpsl3yWeoyoO",
      "Yv5nk9GNAXKNRLnfR2tN"
    ],
    "serviceAreas": [
      "vD2qumxBO9WkRJPUloI7"
    ],
    "companies": [
      "7Rk1pQm4Nx2LbV8c"
    ],
    "payroll": {
      "workerType": "employee",
      "payBasis": "hourly",
      "hourlyRate": 32.5,
      "annualSalary": null,
      "salaryPeriod": "yearly",
      "currency": "USD",
      "commission": 10,
      "commissionExcludesTaxAndFees": true,
      "commissionRule": null,
      "paySchedule": "weekly",
      "weekStartsOn": "monday",
      "timezone": "America/New_York",
      "allowBonuses": false,
      "overtime": {
        "enabled": true,
        "afterHoursPerWeek": 40,
        "multiplier": 1.5
      },
      "breaks": {
        "enabled": true,
        "paid": false,
        "autoDeductMinutes": 30,
        "afterHours": 6,
        "deductsFromShift": true
      },
      "deductions": {
        "enabled": true,
        "estimatedTaxPercent": 22,
        "items": [
          {
            "id": "ded_health",
            "label": "Health plan",
            "kind": "pre_tax",
            "mode": "amount",
            "value": 120
          }
        ]
      }
    }
  }
}