RoadOps Developer Docs

List pass types

GET/v1/teams/{teamId}/pass-types

Lists pass types for a team.

Required scopes: pass_type:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`query.limit`	`integer` Maximum number of records to return. Defaults to 50 and is capped at 200.
`query.cursor`	`string` Cursor returned by page.nextCursor from the previous list response.

Response 200

`data`	`object[]`
`data[].name`	`string`
`data[].abbreviation`	`string`
`data[].kind`	`"pass"` Catalog entry kind.
`data[].isArchived`	`boolean`
`data[].id`	`string:uuid`
`data[].orgId`	`string:uuid`
`data[].isDeleted`	`boolean`
`data[].version`	`integer` Current pass type aggregate version.
`data[].createdAt`	`string:date-time` ISO 8601 timestamp when the pass type was created.
`data[].createdBy`	`string` User identifier that created the pass type.
`data[].updatedAt`	`string:date-time` ISO 8601 timestamp when the pass type was last updated.
`data[].updatedBy`	`string` User identifier that last updated the pass type.
`data[].cursor`	`integer` Latest event-ledger cursor projected into this pass type record.
`page`	`object`
`page.limit`	`integer` Maximum number of records returned in this page.
`page.nextCursor`	`string \| null` Cursor to pass as the next request's cursor query parameter, or null when there are no more results.
`meta`	`object`
`meta.cursor`	`number \| null` Highest record cursor represented by this response.

Create a pass type

POST/v1/teams/{teamId}/pass-types

Accepts a command to create a pass type.

Required scopes: pass_type:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`name`required	`string`
`abbreviation`required	`string`
`isArchived`	`boolean`
`id`	`string:uuid` Optional caller-supplied pass type ID. RoadOps generates one when omitted.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Retrieve a pass type

GET/v1/teams/{teamId}/pass-types/{passTypeId}

Returns one pass type by ID.

Required scopes: pass_type:read

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.passTypeId`required	`string:uuid` Pass type identifier.

Response 200

`data`	`object`
`data.name`	`string`
`data.abbreviation`	`string`
`data.kind`	`"pass"` Catalog entry kind.
`data.isArchived`	`boolean`
`data.id`	`string:uuid`
`data.orgId`	`string:uuid`
`data.isDeleted`	`boolean`
`data.version`	`integer` Current pass type aggregate version.
`data.createdAt`	`string:date-time` ISO 8601 timestamp when the pass type was created.
`data.createdBy`	`string` User identifier that created the pass type.
`data.updatedAt`	`string:date-time` ISO 8601 timestamp when the pass type was last updated.
`data.updatedBy`	`string` User identifier that last updated the pass type.
`data.cursor`	`integer` Latest event-ledger cursor projected into this pass type record.
`meta`	`object`
`meta.cursor`	`integer` Highest record cursor represented by this response.

Update a pass type

PATCH/v1/teams/{teamId}/pass-types/{passTypeId}

Accepts a command to update pass type fields.

Required scopes: pass_type:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.passTypeId`required	`string:uuid` Pass type identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`expectedVersion`	`integer` Optional aggregate version guard.
`name`	`string` Updated pass type name.
`abbreviation`	`string` Updated pass type abbreviation.
`isArchived`	`boolean` Whether this pass type is archived.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Delete a pass type

DELETE/v1/teams/{teamId}/pass-types/{passTypeId}

Accepts a command to delete a pass type.

Required scopes: pass_type:write

Parameters

`path.teamId`required	`string:uuid` Team identifier.
`path.passTypeId`required	`string:uuid` Pass type identifier.
`header.Idempotency-Key`	`string:uuid` Optional caller-generated UUID used to make mutation retries safe. Reuse the same UUID only when retrying the same request.

Request body (application/json)

`deletedAt`	`string:date-time` Optional deletion timestamp.

Response 202

`commandId`	`string:uuid` Command identifier accepted into the RoadOps command ledger.
`resourceId`	`string:uuid` Identifier of the resource targeted by the command.
`resourceType`	`string` Resource type targeted by the command.
`status`	`"applied"` Command dispatch status.
`aggregateVersion`	`integer` Aggregate version produced by the accepted command.
`cursor`	`integer` Event-ledger cursor for the accepted update. Refetch until returned records reach this cursor.
`links`	`object`
`links.refetch`	`string` Relative URL to refetch the affected resource.

Pass Types

List pass types

Parameters

Response 200

Create a pass type

Parameters

Request body (application/json)

Response 202

Retrieve a pass type

Parameters

Response 200

Update a pass type

Parameters

Request body (application/json)

Response 202

Delete a pass type

Parameters

Request body (application/json)

Response 202