> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tilta.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# List credit facilities
> Retrieve a paginated list of credit facilities across all buyers on your platform. Filter by status to monitor credit utilization and facility health.
This endpoint returns a paginated list of credit facilities across all buyers registered on your platform. Use it to monitor overall credit utilization or audit facility statuses in bulk. Unlike the per-buyer facility endpoint, this view gives you a platform-wide perspective – useful for risk monitoring dashboards and customer success workflows.
Pass `buyer_external_ids` to pull facilities for a known set of buyers in one call, rather than making one [Retrieve
facility](/api-reference/facilities/retrieve-facility) request per buyer.
## OpenAPI
````yaml GET /v1/facilities
openapi: 3.0.0
info:
version: 0.0.1
title: Tilta API
description: Tilta API documentation
servers:
- url: https://api.tilta.io
description: Tilta Production API
- url: https://api.tilta-sandbox.io
description: Tilta Sandbox API
security: []
paths:
/v1/facilities:
get:
tags:
- Credit Facilities
summary: List credit facilities
description: Returns credit facilities for the given filter criteria.
parameters:
- schema:
$ref: '#/components/schemas/limit'
required: false
description: The number of records to be taken.
name: limit
in: query
- schema:
allOf:
- $ref: '#/components/schemas/offset'
- nullable: true
required: false
description: The number of records to be skipped.
name: offset
in: query
- schema:
type: string
description: List of buyer external IDs to filter by.
example: buyer_id_1,buyer_id_2
required: false
description: List of buyer external IDs to filter by.
name: buyer_external_ids
in: query
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
properties:
limit:
type: integer
minimum: 0
description: The number of taken records.
example: 100
offset:
type: integer
minimum: 0
description: The number of skipped records.
example: 0
total:
type: integer
minimum: 0
description: Total number of records
example: 140
items:
type: array
items:
type: object
properties:
buyer_external_id:
type: string
maxLength: 100
pattern: ^[a-zA-Z0-9-_]+$
description: Unique identifier for buyer.
example: 5f6374a46a5e8e0104aa5cd4
pending_orders_amount:
type: integer
description: >-
Blocked by pending deferred orders portion of the
Credit Limit. As minimum currency unit (e.g
cents/pence).
example: 2500
risk_band:
type: string
enum:
- REJECT
- A1
- A2
- B1
- B2
- C1
- C2
- D1
- D2
created_at:
type: number
description: >-
Timestamp indicating when the facility was created
(unix time in seconds).
example: 1582896122
updated_at:
type: number
description: >-
Timestamp indicating the last time the facility was
updated (unix time in seconds).
example: 1582896122
status:
type: string
enum:
- ACTIVE
- PENDING
- FROZEN
- EXPIRED
description: Status of the Active facility
example: ACTIVE
reviewed_at:
type: number
nullable: true
description: Review Date of the Active facility
currency:
type: string
enum:
- EUR
- GBP
- USD
- CHF
- PLN
- CZK
- RON
- BGN
- DKK
- HUF
- SEK
- NOK
- JPY
- AUD
- NZD
- CAD
description: ISO 4217 three-letter currency code.
total_amount:
type: integer
description: >-
Total credit limit available to the Buyer. As
minimum currency unit (e.g cents/pence).
example: 10000
available_amount:
type: integer
description: >-
Available portion of the Credit Limit. As minimum
currency unit (e.g cents/pence).
example: 5200
used_amount:
type: integer
description: >-
Credit Limit portion currently in use (not repaid).
As minimum currency unit (e.g cents/pence).
example: 4800
required:
- buyer_external_id
- pending_orders_amount
- risk_band
- created_at
- updated_at
- status
- reviewed_at
- currency
- total_amount
- available_amount
- used_amount
additionalProperties: false
description: List of credit facilities.
required:
- limit
- offset
- total
- items
additionalProperties: false
description: List of credit facilities
'400':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/badRequestSchema'
'401':
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/unauthorizedRequestSchema'
security:
- bearerAuth: []
components:
schemas:
limit:
type: integer
description: The number of records to be taken.
example: 100
default: 100
maximum: 100
offset:
type: integer
description: The number of records to be skipped.
example: 0
default: 0
badRequestSchema:
type: object
properties:
code:
type: string
description: Error code
example: BAD_REQUEST
error:
type: string
description: Error message for debugging purposes
example: Request validation failed. 1 issue found.
issues:
type: array
items:
type: object
properties:
code:
type: string
description: Issue code
example: INVALID_TYPE
path:
type: string
description: Issue path starting with body, params, querystring, or headers
example: body.registered_at
message:
type: string
description: Issue message for debugging purposes
example: Invalid type
required:
- code
- path
- message
description: List of issues
example:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
required:
- code
- error
- issues
description: Bad Request, see error message for details.
example:
code: BAD_REQUEST
error: Request validation failed. 1 issue found.
issues:
- code: INVALID_TYPE
path: body.registered_at
message: Invalid type
unauthorizedRequestSchema:
type: object
properties:
error:
type: string
description: Error details.
example: Unauthorized
code:
type: string
description: Error code.
example: UNAUTHORIZED
required:
- error
- code
description: Unauthorized Request.
example:
error: Unauthorized
code: UNAUTHORIZED
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: Your Tilta API key, sent as `Bearer `.
````