Lookup lists

Base URL: https://couplrfsm.com/api/v1. Conventions shared by every endpoint (examples, ids, dates, money) are on the API reference page. Errors, pagination and idempotency are in Errors, limits and retries.

List job types#

GET /api/v1/job-types · requires the jobs:read ability

The company's job types, by name. Not paginated.

Example request

curl "https://couplrfsm.com/api/v1/job-types" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 1,
            "name": "Repair"
        }
    ]
}

Errors

List technicians#

GET /api/v1/technicians · requires the jobs:read ability

Technicians a job can be assigned to. Use an id as assigned_tech_id, in assigned_tech_ids or as lead_tech_id. Not paginated.

Example request

curl "https://couplrfsm.com/api/v1/technicians" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 1,
            "name": "Repair"
        }
    ]
}

Errors

List tags#

GET /api/v1/tags · requires the jobs:read ability

Tags that can be put on a job with tag_ids. Not paginated.

Example request

curl "https://couplrfsm.com/api/v1/tags" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 1,
            "name": "Repair"
        }
    ]
}

Errors

List lead sources#

GET /api/v1/lead-sources · requires the jobs:read ability

Where customers come from. Use an id as lead_source_id. Not paginated.

Example request

curl "https://couplrfsm.com/api/v1/lead-sources" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 1,
            "name": "Repair"
        }
    ]
}

Errors

List market segments#

GET /api/v1/market-segments · requires the jobs:read ability

The company's market segments. Use an id as market_segment_id. Not paginated.

Example request

curl "https://couplrfsm.com/api/v1/market-segments" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example response (200)

{
    "data": [
        {
            "id": 1,
            "name": "Repair"
        }
    ]
}

Errors