SupportJoin Discord!
API Reference

Get styleguide components

get
https://api.zeplin.dev/v1/styleguides//components

Returns components in a styleguide that user has access.

See Styleguide docs for more details about how linked_project and linked_styleguide parameters can be used to retrieve resources from styleguides that user is eligible to access.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns Component[]

Path Params
string
required
/^[0-9a-f]{24}$/i

Styleguide id

Query Params
string
/^[0-9a-f]{24}$/i

Filter by section id

string
enum
Defaults to section

Sort components by their section or their created date

Allowed:
string
/^[0-9a-f]{24}$/i

Reference project id

string
/^[0-9a-f]{24}$/i

Reference styleguide id

boolean
Defaults to false

Whether to include linked styleguides or not

boolean
Defaults to false

Whether to include the latest version data in the Component object

integer
1 to 100
Defaults to 30

Pagination limit

integer
≥ 0
Defaults to 0

Pagination offset

Responses

Updated 28 days ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 28 days ago