> ## Documentation Index > Fetch the complete documentation index at: https://docs.spott.io/llms.txt > Use this file to discover all available pages before exploring further. # List offices > Returns a cursor-paginated list of offices. ## OpenAPI ````yaml /api-reference/openapi.json get /offices openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /offices: get: tags: - Offices summary: List offices description: Returns a cursor-paginated list of offices. operationId: getOffices parameters: - name: limit required: false in: query description: 'Number of offices to return (min: 1, max: 100, default: 50).' schema: minimum: 1 maximum: 100 default: 50 example: 50 type: integer - name: cursor required: false in: query description: Opaque cursor from the previous response. schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetOfficesResponseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '400': description: Bad Request content: application/json: schema: $ref: '#/components/schemas/ValidationExceptionDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '404': description: Not Found content: application/json: schema: $ref: '#/components/schemas/GlobalNotFoundApiErrorDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '409': description: Conflict content: application/json: schema: $ref: '#/components/schemas/GlobalConflictApiErrorDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' '429': description: >- Too Many Requests. The published limit for this endpoint is 600 requests per minute per workspace. The limit in force for your workspace can differ from it in either direction — a workspace on a free trial can be capped lower, and a higher limit can be arranged through support — so the headers, not this number, are authoritative. Read the RateLimit-Policy response header for the quota actually in force and RateLimit for what is left of the current window; on a 429, Retry-After gives the seconds to wait. content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' Retry-After: $ref: '#/components/headers/Retry-After' '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/InternalServerErrorDto' headers: RateLimit: $ref: '#/components/headers/RateLimit' RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' security: - x-api-key: [] components: schemas: GetOfficesResponseDto: type: object properties: items: type: array items: $ref: '#/components/schemas/OfficeItemDto' pagination: $ref: '#/components/schemas/OfficeCursorPaginationDto' required: - items - pagination ValidationExceptionDto: type: object properties: status: type: number const: 400 category: type: string enum: - SCHEMA_VALIDATION_FAILED message: type: string enum: - Validation failed requestId: type: string errors: type: array items: $ref: '#/components/schemas/ValidationIssueDto' required: - status - category - message - requestId - errors GlobalNotFoundApiErrorDto: anyOf: - $ref: '#/components/schemas/ResourceNotFoundApiErrorDto' - $ref: '#/components/schemas/RelatedResourceNotFoundApiErrorDto' GlobalConflictApiErrorDto: anyOf: - $ref: '#/components/schemas/ResourceAlreadyExistsApiErrorDto' - $ref: '#/components/schemas/ResourceLockTimeoutApiErrorDto' ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 category: $ref: '#/components/schemas/ApiErrorCategoryDto' message: type: string requestId: type: string required: - status - message - requestId InternalServerErrorDto: type: object properties: status: type: number const: 500 category: type: string enum: - INTERNAL_ERROR message: type: string enum: - Internal server error requestId: type: string required: - status - category - message - requestId OfficeItemDto: type: object properties: id: type: string name: type: string emailAddresses: type: array items: $ref: '#/components/schemas/OrganizationalEmailAddressDto' phoneNumbers: type: array items: $ref: '#/components/schemas/OrganizationalPhoneNumberDto' createdAt: $ref: '#/components/schemas/DateISO' required: - id - name - emailAddresses - phoneNumbers - createdAt OfficeCursorPaginationDto: type: object properties: cursor: type: - string - 'null' required: - cursor ValidationIssueDto: oneOf: - $ref: '#/components/schemas/ValidationRequiredDto' - $ref: '#/components/schemas/ValidationInvalidEmptyStringDto' - $ref: '#/components/schemas/ValidationUnknownFieldDto' - $ref: '#/components/schemas/ValidationTooSmallDto' - $ref: '#/components/schemas/ValidationTooBigDto' - $ref: '#/components/schemas/ValidationInvalidTypeDto' - $ref: '#/components/schemas/ValidationInvalidValueDto' - $ref: '#/components/schemas/ValidationInvalidEmailDto' - $ref: '#/components/schemas/ValidationInvalidUuidDto' - $ref: '#/components/schemas/ValidationInvalidUrlDto' - $ref: '#/components/schemas/ValidationInvalidDatetimeDto' - $ref: '#/components/schemas/ValidationInvalidDateDto' - $ref: '#/components/schemas/ValidationInvalidTimeDto' - $ref: '#/components/schemas/ValidationInvalidDurationDto' - $ref: '#/components/schemas/ValidationInvalidIpv4Dto' - $ref: '#/components/schemas/ValidationInvalidIpv6Dto' - $ref: '#/components/schemas/ValidationInvalidJsonStringDto' - $ref: '#/components/schemas/ValidationInvalidJwtDto' - $ref: '#/components/schemas/ValidationInvalidRegexDto' - $ref: '#/components/schemas/ValidationInvalidPhoneNumberDto' - $ref: '#/components/schemas/ValidationInvalidDomainDto' - $ref: '#/components/schemas/ValidationInvalidHttpsUrlDto' - $ref: '#/components/schemas/ValidationInvalidTimezoneDto' - $ref: '#/components/schemas/ValidationPaginationOffsetExceededDto' ResourceNotFoundApiErrorDto: type: object properties: status: type: number const: 404 category: type: string enum: - RESOURCE_NOT_FOUND message: type: string enum: - Resource not found requestId: type: string required: - status - category - message - requestId RelatedResourceNotFoundApiErrorDto: type: object properties: status: type: number const: 404 category: type: string enum: - RESOURCE_NOT_FOUND message: type: string enum: - Related resource not found requestId: type: string required: - status - category - message - requestId ResourceAlreadyExistsApiErrorDto: type: object properties: status: type: number const: 409 category: type: string enum: - RESOURCE_ALREADY_EXISTS message: type: string enum: - Resource already exists requestId: type: string required: - status - category - message - requestId ResourceLockTimeoutApiErrorDto: type: object properties: status: type: number const: 409 category: type: string enum: - RESOURCE_BUSY message: type: string enum: - >- Lock could not be acquired for this resource, please try again later. requestId: type: string required: - status - category - message - requestId ApiErrorCategoryDto: type: string enum: - MALFORMED_REQUEST - SCHEMA_VALIDATION_FAILED - DOMAIN_VALIDATION_FAILED - OPERATION_LIMIT_EXCEEDED - AUTHENTICATION_REQUIRED - AUTHENTICATION_FAILED - SECURITY_CHALLENGE_REQUIRED - SECURITY_CHALLENGE_FAILED - PERMISSION_DENIED - ENTITLEMENT_REQUIRED - PROVIDER_AUTHENTICATION_REQUIRED - PROVIDER_AUTHENTICATION_FAILED - CONFIGURATION_REQUIRED - RESOURCE_NOT_FOUND - RESOURCE_ALREADY_EXISTS - RESOURCE_EXPIRED - RESOURCE_BUSY - RESOURCE_STATE_CONFLICT - QUOTA_EXCEEDED - RATE_LIMITED - UNSUPPORTED_OPERATION - UPSTREAM_REJECTED - TIMEOUT - TEMPORARILY_UNAVAILABLE - INTERNAL_ERROR OrganizationalEmailAddressDto: type: object properties: email: type: string format: email pattern: >- ^(([^<>()\[\]\\.,;:\s@"]+(\.[^<>()\[\]\\.,;:\s@"]+)*)|(".+"))@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}])|(([a-zA-Z\-0-9]+\.)+[a-zA-Z]{2,}))$ purpose: anyOf: - type: string enum: - personal - work - type: 'null' isPrimary: type: boolean required: - email - purpose - isPrimary OrganizationalPhoneNumberDto: type: object properties: phoneNumber: $ref: '#/components/schemas/PhoneNumber' purpose: anyOf: - type: string enum: - personal - work - type: 'null' isPrimary: type: boolean required: - phoneNumber - purpose - isPrimary DateISO: format: date-time anyOf: - type: string format: date-time pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ - type: string format: date pattern: >- ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))$ ValidationRequiredDto: type: object properties: code: type: string enum: - REQUIRED path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidEmptyStringDto: type: object properties: code: type: string enum: - INVALID_EMPTY_STRING path: type: string message: type: string received: {} required: - code - path - message ValidationUnknownFieldDto: type: object properties: code: type: string enum: - UNKNOWN_FIELD path: type: string message: type: string received: {} keys: type: array items: type: string required: - code - path - message - keys ValidationTooSmallDto: type: object properties: code: type: string enum: - TOO_SMALL path: type: string message: type: string received: {} minimum: type: number inclusive: type: boolean origin: type: string required: - code - path - message - minimum - inclusive - origin ValidationTooBigDto: type: object properties: code: type: string enum: - TOO_BIG path: type: string message: type: string received: {} maximum: type: number inclusive: type: boolean origin: type: string required: - code - path - message - maximum - inclusive - origin ValidationInvalidTypeDto: type: object properties: code: type: string enum: - INVALID_TYPE path: type: string message: type: string received: {} expected: type: string required: - code - path - message - expected ValidationInvalidValueDto: type: object properties: code: type: string enum: - INVALID_VALUE path: type: string message: type: string received: {} expected: {} required: - code - path - message ValidationInvalidEmailDto: type: object properties: code: type: string enum: - INVALID_EMAIL path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidUuidDto: type: object properties: code: type: string enum: - INVALID_UUID path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidUrlDto: type: object properties: code: type: string enum: - INVALID_URL path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidDatetimeDto: type: object properties: code: type: string enum: - INVALID_DATETIME path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidDateDto: type: object properties: code: type: string enum: - INVALID_DATE path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidTimeDto: type: object properties: code: type: string enum: - INVALID_TIME path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidDurationDto: type: object properties: code: type: string enum: - INVALID_DURATION path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidIpv4Dto: type: object properties: code: type: string enum: - INVALID_IPV4 path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidIpv6Dto: type: object properties: code: type: string enum: - INVALID_IPV6 path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidJsonStringDto: type: object properties: code: type: string enum: - INVALID_JSON_STRING path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidJwtDto: type: object properties: code: type: string enum: - INVALID_JWT path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidRegexDto: type: object properties: code: type: string enum: - INVALID_REGEX path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidPhoneNumberDto: type: object properties: code: type: string enum: - INVALID_PHONE_NUMBER path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidDomainDto: type: object properties: code: type: string enum: - INVALID_DOMAIN path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidHttpsUrlDto: type: object properties: code: type: string enum: - INVALID_HTTPS_URL path: type: string message: type: string received: {} required: - code - path - message ValidationInvalidTimezoneDto: type: object properties: code: type: string enum: - INVALID_TIMEZONE path: type: string message: type: string received: {} required: - code - path - message ValidationPaginationOffsetExceededDto: type: object properties: code: type: string enum: - PAGINATION_OFFSET_EXCEEDED path: type: string message: type: string received: {} maximum: type: number required: - code - path - message - maximum PhoneNumber: description: Phone number in E.164 format type: string headers: RateLimit: description: >- Quota state for this endpoint, as an RFC 8941 structured field (draft-ietf-httpapi-ratelimit-headers). The quoted value names the policy — the operationId of the endpoint the counters belong to. `r` is how many requests are left in the current window, `t` how many seconds remain before it resets. schema: type: string example: '"getCandidates";r=417;t=23' RateLimit-Policy: description: >- The policy the RateLimit header reports against, as an RFC 8941 structured field. `q` is the quota — the requests allowed per window — and `w` the window length in seconds. Limits are per endpoint, so the quota differs between operations. This is the quota in force for the calling workspace, which can be lower or higher than the default published on the operation; treat it as authoritative. schema: type: string example: '"getCandidates";q=600;w=60' Retry-After: description: >- Seconds to wait before retrying. Sent on 429 responses; it matches the `t` parameter of the RateLimit header. schema: type: integer example: 23 securitySchemes: x-api-key: type: apiKey name: x-api-key in: header description: >- API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.