Skip to main content
GET
/
v1
/
replica
List Replicas
curl --request GET \
  --url https://api.replicas.dev/v1/replica \
  --header 'Authorization: Bearer <token>'
{
  "replicas": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "active",
      "source": "api",
      "created_at": "2023-11-07T05:31:56Z",
      "last_activity_at": "2023-11-07T05:31:56Z",
      "repositories": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "url": "<string>"
        }
      ],
      "pull_requests": [
        {
          "repository": "<string>",
          "number": 123,
          "url": "<string>"
        }
      ]
    }
  ],
  "total": 123,
  "page": 123,
  "limit": 123,
  "total_pages": 123
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Settings > API Keys.

Query Parameters

page
integer
default:1

Page number for pagination

Required range: x >= 1
limit
integer
default:10

Number of items per page

Required range: 1 <= x <= 100
user_id
string

Filter replicas by the user who created them

source
enum<string>

Filter replicas by creation source

Available options:
api,
dashboard,
slack,
linear,
github,
automation
status
enum<string>

Filter replicas by status

Available options:
active,
sleeping,
preparing

Response

Successful response

replicas
object[]
required

Array of replicas

total
integer
required

Total number of replicas matching the filters

page
integer
required

Current page number

limit
integer
required

Number of items per page

total_pages
integer
required

Total number of pages