Useful API endpoints for frameworks

When working on a framework, often you’ll need to investigate a particular supplier or service.

This page gives some useful API endpoints that you can access via Postman or curl. Usually you’ll have been given either a supplier ID e.g. 123456 or a supplier name, e.g CUSTARD PIES INC.

Note that some endpoints are ‘list’ views, and are paginated (100 results per page).

GDS network/VPN access is required to access API endpoints, plus the correct API token for the stage.

Users

List all users for a supplier:

/users?supplier_id=123456

Draft services

List all draft services for a supplier:

/draft-services/framework/g-cloud-23?supplier_id=123456
/draft-services/framework/g-cloud-23?supplier_id=123456&status=submitted

List draft services for everyone:

/draft-services/framework/g-cloud-23
/draft-services/framework/g-cloud-23?status=submitted

Get a supplier’s draft services across all frameworks:

/draft-services?supplier_id=123456

Declarations

Get a supplier’s declaration (includes registered details and ‘onFramework’ status):

/suppliers/123456/frameworks/g-cloud-23

Get all frameworks a supplier has applied to:

/suppliers/123456/frameworks

Supplier accounts

Get a supplier by ID:

/suppliers/123456

List suppliers by name:

/suppliers?prefix=custard+pies   # All suppliers beginning 'custard pies'
/suppliers?name=pies             # All suppliers containing 'pies'

Get a supplier by DUNS number:

/suppliers?duns_number=987654321