mirror of
https://github.com/lingble/twenty.git
synced 2025-11-21 16:34:55 +00:00
3d5a364e29
* Website improvement * Improve website design * Start writing script for user guide * Begin adding user guide
30 lines
994 B
Plaintext
30 lines
994 B
Plaintext
---
|
|
title: REST API
|
|
sidebar_position: 3
|
|
sidebar_custom_props:
|
|
icon: TbApi
|
|
---
|
|
|
|
To use the REST API, you will need an API key.
|
|
Connect to your Twenty account ang do to Setting > Developers to generate one.
|
|
|
|
## Using Postman?
|
|
|
|
You can use [Postman](https://www.postman.com/) to interact with your Twenty objects using the API.
|
|
You will need to provide your API key as a Bearer token,
|
|
see [Bearer Token Postman Doc](https://learning.postman.com/docs/sending-requests/authorization/authorization-types/#bearer-token)
|
|
if needed.
|
|
|
|
## Programmatic use?
|
|
|
|
You can call the REST API in your application using this endpoint
|
|
[https://api.twenty.com/rest](https://api.twenty.com/rest).
|
|
You will need to provide your API key as a Bearer token in
|
|
your `headers.Authorization = 'Bearer <YOUR_API_KEY>'`.
|
|
|
|
## Try the REST API Playground
|
|
|
|
You can use the browser-based, interactive
|
|
[REST API playground documentation](https://docs.twenty.com/rest-api)
|
|
to Create, Read, Update or Delete your workspace objects.
|