Sign in
Applications

List applications

Returns a paginated list of applications in the specified zone. Use cursor pagination via after/before. Sort: comma-separated field list; prefix with - for descending. Use expand[]=total_count to include the matching row count. Filter by exact slug via filter[slug] and by exact identifier via filter[identifier]. Search via query[name] / query[identifier] / query[] (substring match, OR'd across repeated values). query[] matches against name and identifier. Pass filter[id] (repeatable, max 100) to restrict results to a known set of applications — mutually exclusive with after/before (returns 400 if combined). When filter[id] is set, limit is ignored and the response contains every requested application that exists in the zone, in a single page. IDs not in the zone are silently omitted.

get/zones/{zoneId}/applications

Path parameters

zoneIdstring required

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
string

Filter by exact application slug

OR
string[]
string

Filter by exact application identifier

OR
string[]
string

Restrict results to applications with this publicId. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
slugstring
identifierstring
string

Search by name (substring match)

OR
string[]
string

Search by identifier (substring match)

OR
string[]
string

Search across name and identifier (substring match)

OR
string[]
sortstring

Comma-separated sort fields. Prefix with - for descending. Allowed: created_at, name, identifier

Response

Default Response

Changes

Changed in 6 of the 23 revisions of this API.5620

  • d65d51379d9321See the full diff
    • ●

      deleted the query request parameter traits[]

      request-parameter-removed

    • ●

      deleted the query request parameter traits[all]

      request-parameter-removed

    • ○

      added the non-success response with the status 400

      response-non-success-status-added

  • 2f5033ed44911See the full diff
    • ○

      added the optional property items/items/metadata/icon_url to the response with the 200 status

      response-optional-property-added

  • 6149152cee43339See the full diff
    • ▲

      the page_info response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ▲

      removed the required property page_info/has_next_page from the response with the 200 status

      response-required-property-removed

    • ▲

      removed the required property page_info/has_previous_page from the response with the 200 status

      response-required-property-removed

    • ●

      deleted the query request parameter cursor

      request-parameter-removed

    • ●

      removed the optional property page_info/end_cursor from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property page_info/start_cursor from the response with the 200 status

      response-optional-property-removed

    • ○

      added the new optional query request parameter filter[id]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[identifier]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter filter[slug]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter query[]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter query[identifier]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter query[name]

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sort

      new-optional-request-parameter

    • ○

      added iam_PageInfo to the page_info response property allOf list for the response status 200

      response-property-all-of-added

    • ○

      response property page_info deprecated

      response-property-deprecated

  • 932699a5ea161See the full diff
    • ○

      added the required property items/items/consent to the response with the 200 status

      response-required-property-added

  • d3d69f45bfed13See the full diff
    • ●

      removed the optional property items/items/traits from the response with the 200 status

      response-optional-property-removed

    • ○

      the endpoint scheme security OAuth2 was added to the API

      api-security-added

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security iam_bearerAuth was removed from the API

      api-security-removed

    This revision also has 8 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • cb43483cd1b325See the full diff
    • ▲

      for the query request parameter limit, default value was changed from 100 to 20

      request-parameter-default-value-changed

    • ▲

      for the query request parameter limit, the max was decreased from 1000.00 to 100.00

      request-parameter-max-decreased

    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter before

      new-optional-request-parameter

    • ○

      added the new optional query request parameter expand[]

      new-optional-request-parameter

    • ○

      added the required property items/items/owner_type to the response with the 200 status

      response-required-property-added

    • ○

      added the required property pagination to the response with the 200 status

      response-required-property-added