API

소개 (Introduction)

Relate Public API의 인증, Base URL, 페이지네이션 등 기본 사용법을 안내합니다.

Relate Public API로 워크스페이스의 연락처·조직·노트·딜·리스트 등 CRM 데이터를 프로그래밍 방식으로 다룰 수 있습니다.

#Base URL

모든 엔드포인트는 아래 Base URL을 기준으로 합니다.

https://api.relate.so/v1
Copy

#인증 (Authorization)

모든 요청에는 API 키를 Authorization 헤더에 Bearer 토큰으로 담아야 합니다.

curl https://api.relate.so/v1/.. \
  -H "Authorization: Bearer {API key}"
Copy

#API 키 발급

API 키 발급, 요금제, 사용법 관련 문의는 릴레잇 팀으로 연락해주세요. we@relate.so 또는 앱 내 채팅으로 문의하시면 안내해드립니다.

#페이지네이션 (Pagination)

모든 목록(list) API는 first, after 파라미터로 offset 기반 페이지네이션을 지원합니다. 예를 들어 20번째 이후 30개를 가져오려면 ?first=30&after=20 을 추가합니다. 생략 시 first는 25, after는 0이 기본값입니다.

목록 응답 형식:

{
  "data": [...],
  "pagination": {
    "end_cursor": 25,
    "has_next_page": true,
    "total_count": 123
  }
}
Copy

"data"의 리소스는 특별한 언급이 없으면 updated_at 기준 최신순으로 정렬되어, 가장 최근에 업데이트된 리소스가 먼저 나옵니다.

#업데이트된 리소스 필터링

모든 목록 API는 특정 시점 이후 업데이트된 리소스만 필터링할 수도 있습니다. 요청에 ?updated_after={unix timestamp} 를 추가하세요.