List project authority rows
Projects module
GET/project-authoritiesprojectAuthorities.list
An authority having jurisdiction over a project: a responder agency of the jurisdiction of the project's venue (xpms.jurisdiction_agency), one row per service and agency. A project without a venue has none. Returns a cursor page of project authority rows the caller may see. The default order is `project_id`, then `service`, then `agency` ascending. Supports sparse fieldsets and the filter grammar.
- Requires the capability projects.project.read.
- OAuth scopes: projects.
- Cursor-paginated: limit, cursor, fields, sort and filter apply.
- Error statuses: 400, 401, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Constraints: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Constraints: length 1 to any |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
| sort | Sort | No | Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Constraints: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$ |
| filter | Filter | No | Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND. |
Response 200: a page of ProjectAuthority
| Field | Type | Required | Description |
|---|---|---|---|
| project_id | string (uuid) | Yes | Identifier of the project. |
| service | string | Yes | Responder service the agency provides.Constraints: length 1 to 100 |
| agency | string | Yes | Agency having jurisdiction.Constraints: length 1 to 300 |
| contact | string | null | Yes | How to reach the agency.Constraints: length 1 to 300 |
{
"data": [
{
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"service": "fire",
"agency": "Miami-Dade Fire Rescue",
"contact": "911"
}
],
"next_cursor": null
}Code samples
curl -X GET "$XOS_BASE_URL/project-authorities" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.projectAuthorities.listAll()) {
console.log(row);
}for row in xos.project_authorities.list_all():
print(row)xos project-authorities list --all