Skip to main content
GET
/
v1
/
facilities
List Facilities
const options = {
  method: 'GET',
  headers: {'x-api-key': '<x-api-key>', 'x-organization-id': '<x-organization-id>'}
};

fetch('https://api.dcycle.io/v1/facilities', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
{
  "items": {
    "id": "<string>",
    "name": "<string>",
    "address": {},
    "country": "<string>",
    "type": "<string>",
    "status": "<string>",
    "co2e": {},
    "co2e_biomass": {},
    "logistic_factor": {},
    "categories": {},
    "cups_list": {},
    "facility_purpose_type": {},
    "created_at": {},
    "updated_at": {},
    "invoices_in_review_count": 123
  },
  "total": 123,
  "page": 123,
  "size": 123,
  "pages": 123
}

​
List Facilities

Retrieve a paginated list of facilities in your organization with support for filtering by name, country, type, and status.

​
Request

​
Headers

​
x-api-key
string
required
Your API key for authentication
​
x-organization-id
string
required
Your organization UUID

​
Query Parameters

​
name
string
Filter facilities by name (partial match, case-insensitive)Example: "Madrid"
​
country
string
Filter by ISO country codeExample: "ES"
​
type
string
Filter by facility typeExample: "office"
​
status[]
array[string]
Filter by facility statusAvailable values: active, archivedExample: status[]=active
​
page
integer
default:"1"
Page number for pagination
​
size
integer
default:"10"
Number of items per page (max 100)

​
Response

​
items
array[object]
Array of facility objects
​
total
integer
Total number of facilities matching the filter
​
page
integer
Current page number
​
size
integer
Number of items per page
​
pages
integer
Total number of pages

​
Example

curl -X GET "https://api.dcycle.io/v1/facilities?page=1&size=50&status[]=active" \
  -H "x-api-key: ${DCYCLE_API_KEY}" \
  -H "x-organization-id: ${DCYCLE_ORG_ID}"

​
Successful Response

{
  "items": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Madrid Office",
      "type": "office",
      "country": "ES",
      "address": "Calle Gran Vía 1, Madrid",
      "status": "active",
      "co2e": 1250.5,
      "co2e_biomass": 0.0,
      "logistic_factor": 0.8,
      "categories": ["heat", "electricity", "water"],
      "cups_list": ["ES0021000000000001AA"],
      "facility_purpose_type": "facilities",
      "created_at": "2024-11-24T10:30:00Z",
      "updated_at": "2024-11-24T10:30:00Z"
    }
  ],
  "total": 12,
  "page": 1,
  "size": 50,
  "pages": 1
}

Create Facility

Add a new facility

Get Facility

Retrieve a single facility