Command Palette

Search for a command to run...

Log In
Get help

List Services

get/public/v1/services

Returns every Service entered against a Plan in the account, newest Plan start date first. Each Service includes its participant, plan, service coordinator, charge items and charge item sets.

Authorization

  • Authorizationstringrequired

    Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Query parameters

  • filter[search]string

    Partial match on the service name.

    Example:Coordination
  • filter[participant]string

    Filter by participant UUID. Comma-separate to combine values.

    Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
  • filter[service_coordinator]string

    Filter by the service coordinator's user UUID. Comma-separate to combine values.

    Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
  • filter[management_type]string

    Filter by management type. Comma-separate to combine values. One of: ndia, plan, self, unknown.

    Example:ndia
  • filter[status]string

    Filter by where today sits in the Service date range. Comma-separate to combine values. One of: current, ended, not_started.

    Example:current
  • sortstring

    Sort the results. Prefix with '-' for descending. One of: name, start_date, end_date, and the aliases start and end matching the response fields of those names.

    Example:-start_date
  • page[size]integer

    Number of results per page. Minimum 1, maximum 100.

    Default:25
  • page[number]integer

    The page number to retrieve. Use the last_page value from the meta response to determine the total number of pages available.

    Default:1

Response

200application/json

Paginated set of PlanServiceResource

  • dataobject[]required
    ▶Show 14 child attributes
    • idstringrequired
      Example:p1l2a3n4-s5e6-47v8-9b0c-1d2e3f4a5b6c
    • namestringrequired
      Example:Level 2 Coordination
    • amountintegerrequired
      Example:1000000
    • management_typeenum<string>required
      Available options:planselfndiaunknown
    • typestring | nullrequired
      Example:unscheduled_service
    • statusstringrequired
      Example:current
    • startstringrequired
      Example:2024-01-01T00:00:00+00:00
    • endstringrequired
      Example:2024-12-31T00:00:00+00:00
    • participantobjectrequired
      ▶Show 2 child attributes
      • idstringrequired
        Example:p1a2r3t4-e5f6-47a8-9b0c-1d2e3f4a5b6c
      • full_namestringrequired
        Example:John Doe
    • planobjectrequired
      ▶Show 3 child attributes
      • idstringrequired
        Example:9b1deb4d-3b7d-4bad-9bdd-2b0d7b3dcb6d
      • startstringrequired
        Example:2024-01-01
      • endstringrequired
        Example:2024-12-31
    • support_categoryobject | nullrequired
      ▶Show 3 child attributes
      • namestringrequired
        Example:Support Coordination
      • prefixstringrequired
        Example:07
      • groupstringrequired
        Example:Capacity
    • service_coordinatorobject | nullrequired
      ▶Show 4 child attributes
      • idstringrequired
        Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
      • first_namestringrequired
        Example:John
      • last_namestringrequired
        Example:Doe
      • emailstringrequired
        Example:john.doe@example.com
    • charge_itemsobject[]required
      ▶Show 9 child attributes
      • idstringrequired
        Example:c1h2a3r4-g5e6-47i8-9b0c-1d2e3f4a5b6c
      • referencestringrequired
        Example:SUPPORT_COORD_L2
      • numberstringrequired
        Example:07_001_0106_8_3
      • namestringrequired
        Example:Support Coordination Level 2
      • unitstringrequired
        Example:H
      • priceintegerrequired
        Example:10044
      • gst_codestringrequired
        Example:P2
      • default_claim_typestring | nullrequired
        Example:Direct
      • archived_atstring | nullrequired
    • charge_item_setsobject[]required
      ▶Show 6 child attributes
      • idstringrequired
        Example:a1b2c3d4-e5f6-47a8-9b0c-1d2e3f4a5b6c
      • referencestringrequired
        Example:SC-SET-01
      • namestringrequired
        Example:Standard Support Coordination Set
      • charge_rate_patternstringrequired
        Example:variable_weekday
      • gst_codestring | nullrequired
        Example:P2
      • archived_atstring | nullrequired
  • metaobjectrequired
    ▶Show 5 child attributes
    • current_pageintegerrequired≥ 1
    • last_pageintegerrequired≥ 1
    • per_pageintegerrequired≥ 0

      Number of items shown per page.

    • totalintegerrequired≥ 0

      Total number of items being paginated.

    • allowed_sortsstring[]required

      The list of allowed sorts for this endpoint.

Errors

  • 401Unauthenticated
  • 403Authorization error