> ## Documentation Index > Fetch the complete documentation index at: https://api-docs.spott.io/llms.txt > Use this file to discover all available pages before exploring further. # List placement custom attribute definitions > Returns a list of placement custom attribute definitions. Placement attribute definitions are scoped to a placement template. Each item includes its templateId, and the list can be narrowed to a single template with the optional templateId query parameter. ## OpenAPI ````yaml /openapi-private.json get /custom-attributes/placement/definitions openapi: 3.1.0 info: title: Spott API Reference version: '0.1' servers: - url: https://api.gospott.com security: [] tags: [] paths: /custom-attributes/placement/definitions: get: tags: - Custom Attributes summary: List placement custom attribute definitions description: >- Returns a list of placement custom attribute definitions. Placement attribute definitions are scoped to a placement template. Each item includes its templateId, and the list can be narrowed to a single template with the optional templateId query parameter. operationId: listPlacementAttributeDefinitions parameters: - name: page required: false in: query schema: minimum: 0 maximum: 10000 default: 0 type: integer - name: pageSize required: false in: query schema: default: 20 type: integer minimum: 1 maximum: 100 - name: templateId required: false in: query schema: type: string responses: '200': description: >- Successfully retrieved placement custom attribute definitions. Returns items array with pagination info. content: application/json: schema: $ref: '#/components/schemas/PaginatedPlacementAttributeDefinitionsDto' '400': description: Bad Request content: application/json: schema: oneOf: - $ref: '#/components/schemas/ValidationExceptionDto' - $ref: '#/components/schemas/ExceptionBaseDto' '401': description: Unauthorized - invalid or missing authentication content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' '500': description: Error response content: application/json: schema: $ref: '#/components/schemas/ExceptionBaseDto' security: - x-api-key: [] components: schemas: PaginatedPlacementAttributeDefinitionsDto: type: object properties: items: type: array items: $ref: '#/components/schemas/PlacementAttributeDefinitionDto' pagination: $ref: '#/components/schemas/PaginationDto' required: - items - pagination id: PrivatePaginatedPlacementAttributeDefinitionsDto ValidationExceptionDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string errors: type: array items: $ref: '#/components/schemas/ValidationIssueDto' required: - status - message - requestId - errors id: ValidationExceptionDto ExceptionBaseDto: type: object properties: status: type: integer minimum: -9007199254740991 maximum: 9007199254740991 message: type: string requestId: type: string required: - status - message - requestId id: ExceptionBaseDto PlacementAttributeDefinitionDto: type: object properties: id: type: string minLength: 1 label: type: string viewType: type: string definition: $ref: '#/components/schemas/AttributeDefinitionDefinitionPayloadDto' createdAt: $ref: '#/components/schemas/DateISO' modifiedAt: $ref: '#/components/schemas/DateISO' templateId: type: string minLength: 1 required: - id - label - viewType - definition - createdAt - modifiedAt - templateId id: PrivatePlacementAttributeDefinitionDto PaginationDto: type: object properties: totalItems: type: number page: type: number hasNextPage: type: boolean required: - totalItems - page - hasNextPage id: PaginationDto 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' id: ValidationIssueDto AttributeDefinitionDefinitionPayloadDto: anyOf: - $ref: '#/components/schemas/AttributeDefinitionDefinitionStandardPayloadDto' - $ref: '#/components/schemas/AttributeDefinitionDefinitionOptionsPayloadDto' - $ref: '#/components/schemas/AttributeDefinitionDefinitionEntityPayloadDto' - $ref: >- #/components/schemas/AttributeDefinitionDefinitionEntityUnknownPayloadDto - $ref: '#/components/schemas/AttributeDefinitionDefinitionUnknownPayloadDto' id: PrivateAttributeDefinitionDefinitionPayloadDto DateISO: id: 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 id: ValidationRequiredDto ValidationInvalidEmptyStringDto: type: object properties: code: type: string enum: - INVALID_EMPTY_STRING path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidEmptyStringDto 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 id: ValidationUnknownFieldDto 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 id: ValidationTooSmallDto 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 id: ValidationTooBigDto 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 id: ValidationInvalidTypeDto ValidationInvalidValueDto: type: object properties: code: type: string enum: - INVALID_VALUE path: type: string message: type: string received: {} expected: {} required: - code - path - message id: ValidationInvalidValueDto ValidationInvalidEmailDto: type: object properties: code: type: string enum: - INVALID_EMAIL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidEmailDto ValidationInvalidUuidDto: type: object properties: code: type: string enum: - INVALID_UUID path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidUuidDto ValidationInvalidUrlDto: type: object properties: code: type: string enum: - INVALID_URL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidUrlDto ValidationInvalidDatetimeDto: type: object properties: code: type: string enum: - INVALID_DATETIME path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDatetimeDto ValidationInvalidDateDto: type: object properties: code: type: string enum: - INVALID_DATE path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDateDto ValidationInvalidTimeDto: type: object properties: code: type: string enum: - INVALID_TIME path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidTimeDto ValidationInvalidDurationDto: type: object properties: code: type: string enum: - INVALID_DURATION path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDurationDto ValidationInvalidIpv4Dto: type: object properties: code: type: string enum: - INVALID_IPV4 path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidIpv4Dto ValidationInvalidIpv6Dto: type: object properties: code: type: string enum: - INVALID_IPV6 path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidIpv6Dto ValidationInvalidJsonStringDto: type: object properties: code: type: string enum: - INVALID_JSON_STRING path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidJsonStringDto ValidationInvalidJwtDto: type: object properties: code: type: string enum: - INVALID_JWT path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidJwtDto ValidationInvalidRegexDto: type: object properties: code: type: string enum: - INVALID_REGEX path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidRegexDto ValidationInvalidPhoneNumberDto: type: object properties: code: type: string enum: - INVALID_PHONE_NUMBER path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidPhoneNumberDto ValidationInvalidDomainDto: type: object properties: code: type: string enum: - INVALID_DOMAIN path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidDomainDto ValidationInvalidHttpsUrlDto: type: object properties: code: type: string enum: - INVALID_HTTPS_URL path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidHttpsUrlDto ValidationInvalidTimezoneDto: type: object properties: code: type: string enum: - INVALID_TIMEZONE path: type: string message: type: string received: {} required: - code - path - message id: ValidationInvalidTimezoneDto 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 id: ValidationPaginationOffsetExceededDto AttributeDefinitionDefinitionStandardPayloadDto: type: object properties: viewType: type: string enum: - customText - customNumber - customCheckbox - customDate - customTimestamp - customRating - customCurrency - customDateRange - customDuration - customUrl required: - viewType id: PrivateAttributeDefinitionDefinitionStandardPayloadDto AttributeDefinitionDefinitionOptionsPayloadDto: type: object properties: viewType: type: string enum: - customSelect - customMultiSelect options: type: array items: type: string required: - viewType - options id: PrivateAttributeDefinitionDefinitionOptionsPayloadDto AttributeDefinitionDefinitionEntityPayloadDto: type: object properties: viewType: type: string enum: - customEntity - customMultiEntity type: type: string enum: - user required: - viewType - type id: PrivateAttributeDefinitionDefinitionEntityPayloadDto AttributeDefinitionDefinitionEntityUnknownPayloadDto: type: object properties: viewType: type: string enum: - customEntity - customMultiEntity type: type: string required: - viewType - type id: PrivateAttributeDefinitionDefinitionEntityUnknownPayloadDto AttributeDefinitionDefinitionUnknownPayloadDto: type: object properties: viewType: type: string required: - viewType id: PrivateAttributeDefinitionDefinitionUnknownPayloadDto 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. ````