Operations API | Genaya API Reference

Organization

Operations

Read-only reference data - the configured options that write endpoints expect (appointment types, lead sources, tags), plus companies and phone numbers.

GET/appointment-types

List appointment types

Returns the organization's configured appointment types. Several write endpoints accept a value that must match one of these, so list them rather than hard-coding strings. Read-only - managed in the Genaya app. Requires scope: operations: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/appointment-types \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "appointment_type",
      "name": "",
      "description": "",
      "status": "",
      "displayOrder": 0,
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/appointment-types/{id}

Retrieve a appointment type

Returns a single appointment type by id. A record belonging to another organization returns 404 rather than 403, so this can never confirm cross-tenant existence. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

status

string

Whether the option is currently active or has been retired.

displayOrder

integer

nullable

createdAt

string <date-time>

updatedAt

string <date-time>

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/appointment-types/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "appointment_type",
    "name": "",
    "description": "",
    "status": "",
    "displayOrder": 0,
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/lead-sources

List lead sources

Returns the organization's configured lead sources. Several write endpoints accept a value that must match one of these, so list them rather than hard-coding strings. Read-only - managed in the Genaya app. Requires scope: operations: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/lead-sources \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "appointment_type",
      "name": "",
      "description": "",
      "status": "",
      "displayOrder": 0,
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/lead-sources/{id}

Retrieve a lead source

Returns a single lead source by id. A record belonging to another organization returns 404 rather than 403, so this can never confirm cross-tenant existence. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

status

string

Whether the option is currently active or has been retired.

displayOrder

integer

nullable

createdAt

string <date-time>

updatedAt

string <date-time>

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/lead-sources/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "appointment_type",
    "name": "",
    "description": "",
    "status": "",
    "displayOrder": 0,
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/tags

List tags

Returns the organization's configured tags. Several write endpoints accept a value that must match one of these, so list them rather than hard-coding strings. Read-only - managed in the Genaya app. Requires scope: operations: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/tags \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {}
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/tags/{id}

Retrieve a tag

Returns a single tag by id. A record belonging to another organization returns 404 rather than 403, so this can never confirm cross-tenant existence. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

No fields.

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

GET/companies

List companies

Returns the organization's configured companies. Several write endpoints accept a value that must match one of these, so list them rather than hard-coding strings. Read-only - managed in the Genaya app. Requires scope: operations: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/companies \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "company",
      "name": "",
      "email": "",
      "phone": "",
      "timeZone": "",
      "status": "",
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/companies/{id}

Retrieve a company

Returns a single company by id. A record belonging to another organization returns 404 rather than 403, so this can never confirm cross-tenant existence. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

email

string

phone

string

timeZone

string

nullable

status

string

createdAt

string <date-time>

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/companies/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "company",
    "name": "",
    "email": "",
    "phone": "",
    "timeZone": "",
    "status": "",
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/phone-numbers

List phone numbers

Returns the organization's configured phone numbers. Several write endpoints accept a value that must match one of these, so list them rather than hard-coding strings. Read-only - managed in the Genaya app. Requires scope: operations: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/phone-numbers \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "phone_number",
      "phoneNumber": "",
      "name": "",
      "companyId": "",
      "status": "",
      "capabilities": [
        ""
      ],
      "createdAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/phone-numbers/{id}

Retrieve a phone number

Returns a single phone number by id. A record belonging to another organization returns 404 rather than 403, so this can never confirm cross-tenant existence. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

phoneNumber

string

The number in E.164 format.

name

string

companyId

string

nullable

status

string

capabilities

array of string

What the number can do, for example SMS or voice.

createdAt

string <date-time>

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/phone-numbers/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "phone_number",
    "phoneNumber": "",
    "name": "",
    "companyId": "",
    "status": "",
    "capabilities": [
      ""
    ],
    "createdAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/service-areas

List service areas

Returns configured service areas. Polygon geometry is summarized as point counts rather than returned in full. Read-only. Requires scope: operations:read.

Parameters

Query

status

string

Return only service areas matching this status.

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/service-areas \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "service_area",
      "name": "",
      "description": "",
      "coverageMode": "",
      "radiusMiles": 0,
      "metroZip": "",
      "polygonPointCount": 0,
      "pinAreaCount": 0,
      "color": "",
      "status": "",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/service-areas/{id}

Retrieve a service area

Returns a single service area by id. A record belonging to another organization returns 404 rather than 403. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

coverageMode

string

nullable

radiusMiles

number

nullable

metroZip

string

nullable

polygonPointCount

integer

pinAreaCount

integer

color

string

nullable

status

string

createdAt

string <date-time>

updatedAt

string <date-time>

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/service-areas/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "service_area",
    "name": "",
    "description": "",
    "coverageMode": "",
    "radiusMiles": 0,
    "metroZip": "",
    "polygonPointCount": 0,
    "pinAreaCount": 0,
    "color": "",
    "status": "",
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/vendors

List vendors

Returns the organization's vendors. Read-only. Requires scope: operations:read.

Parameters

Query

status

string

Return only vendors matching this status.

vendorsType

string

Return only vendors matching this vendorsType.

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/vendors \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "vendor",
      "name": "",
      "email": "",
      "phone": "",
      "type": "",
      "baseRatePercent": 0,
      "notes": "",
      "logoUrl": "",
      "status": "",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/vendors/{id}

Retrieve a vendor

Returns a single vendor by id. A record belonging to another organization returns 404 rather than 403. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

email

string

phone

string

type

string

nullable

baseRatePercent

number

nullable

notes

string

logoUrl

string

nullable

status

string

createdAt

string <date-time>

updatedAt

string <date-time>

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/vendors/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "vendor",
    "name": "",
    "email": "",
    "phone": "",
    "type": "",
    "baseRatePercent": 0,
    "notes": "",
    "logoUrl": "",
    "status": "",
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/items-and-services

List price book items (items and services)

Returns the price book, including stock levels for tracked products. Read-only. Requires scope: operations:read.

Parameters

Query

itemType

string

Return only price book items matching this itemType.

categoryId

string

Return only price book items matching this categoryId.

status

string

Return only price book items matching this status.

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/items-and-services \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "item_or_service",
      "name": "",
      "description": "",
      "itemType": "",
      "sku": "",
      "barcode": "",
      "manufacturerModel": "",
      "unitPrice": 0,
      "cost": 0,
      "taxable": false,
      "categoryId": "",
      "category": "",
      "inventoryTracked": false,
      "inventoryQuantities": {},
      "continueSellingWhenOutOfStock": false,
      "status": "",
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/items-and-services/{id}

Retrieve a item or service

Returns a single item or service by id. A record belonging to another organization returns 404 rather than 403. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

itemType

string

nullable

sku

string

nullable

barcode

string

nullable

manufacturerModel

string

nullable

unitPrice

number

nullable

cost

number

nullable

taxable

boolean

categoryId

string

nullable

category

string

nullable

inventoryTracked

boolean

inventoryQuantities

object

Stock on hand, keyed by company.

continueSellingWhenOutOfStock

boolean

status

string

createdAt

string <date-time>

updatedAt

string <date-time>

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/items-and-services/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "item_or_service",
    "name": "",
    "description": "",
    "itemType": "",
    "sku": "",
    "barcode": "",
    "manufacturerModel": "",
    "unitPrice": 0,
    "cost": 0,
    "taxable": false,
    "categoryId": "",
    "category": "",
    "inventoryTracked": false,
    "inventoryQuantities": {},
    "continueSellingWhenOutOfStock": false,
    "status": "",
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}

GET/item-categories

List item categories

Returns categories used to group price book items. Read-only. Requires scope: operations: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/item-categories \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "object": "list",
  "data": [
    {
      "id": "",
      "object": "appointment_type",
      "name": "",
      "description": "",
      "status": "",
      "displayOrder": 0,
      "createdAt": "2026-01-15T09:30:00.000Z",
      "updatedAt": "2026-01-15T09:30:00.000Z"
    }
  ],
  "has_more": false,
  "next_cursor": ""
}

GET/item-categories/{id}

Retrieve a item category

Returns a single item category by id. A record belonging to another organization returns 404 rather than 403. Requires scope: operations:read.

Parameters

Path

idrequired

string

Response 200

FieldTypeDescription

id

string

object

string

name

string

description

string

status

string

Whether the option is currently active or has been retired.

displayOrder

integer

nullable

createdAt

string <date-time>

updatedAt

string <date-time>

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/item-categories/{id} \
  -H "Authorization: Bearer gny_live_xxx"

Example response

{
  "data": {
    "id": "",
    "object": "appointment_type",
    "name": "",
    "description": "",
    "status": "",
    "displayOrder": 0,
    "createdAt": "2026-01-15T09:30:00.000Z",
    "updatedAt": "2026-01-15T09:30:00.000Z"
  }
}