Intakes

List intakes

Return a paginated list of intakes, optionally filtered by status or client email.

get/v1/intakes

Request

  • Base URL: https://api.briefgate.dev
  • URL: https://api.briefgate.dev/v1/intakes
  • Auth: HTTP bearer

Query parameters

status'draft' | 'sent' | 'in_progress' | 'completed' | 'archived'

Filter by intake status.

client_emailstring email

Filter by client email address.

folder_idstring

Filter by folder id, or the literal "none" for intakes with no folder. See Folders.

qstring

Case-insensitive substring search across project_name, client.name and client.email. Combines with the other filters.

limitinteger

Number of results to return.

offsetinteger

Pagination offset.

Response

Paginated list of intakes

totalinteger required
limitinteger required
offsetinteger required

Example response

{
  "intakes": [
    {
      "intake_id": "in_01J9Z8X"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.