커스텀테이블 행 목록 조회 API
커스텀테이블의 행 데이터를 조회할 수 있는 API입니다.
테이블은 프릭스 어드민에서 설정한
slug또는 테이블uuid로 식별합니다.행은 API 권한이 연결된 멤버가 속한 팀의 조회 권한 범위로 반환됩니다.
셀 값(
columnItems[].value)은 컬럼 타입에 따라 아래 형식으로 제공됩니다.
STRING
문자열
NUMBER
숫자
BOOLEAN
true / false
DATE
ISO 8601 날짜 문자열
TAG
[{ "id": 5, "name": "자문" }] 형태의 배열
RELATION
대상이 커스텀테이블이면 [{ "uuid", "title" }], 고객이면 [{ "id", "title" }] 배열
LOOKUP
문자열 (참조한 값의 표시 문구)
GET kit-api/v1/custom-tables/{key}/rows
Method: GET Endpoint: kit-api/v1/custom-tables/{key}/rows
key에는 테이블slug또는uuid를 사용할 수 있습니다.
Example
Request Query
limit
목록 개수 (default 10, max 100)
no
offset
스킵할 목록 개수
no
title
행 제목으로 조회 (부분 일치)
no
dealUuids
해당 uuid 속성을 가진 프로젝트들과 연결된 행 조회 (콤마 구분)
no
customerIds
해당 id 속성을 가진 고객들과 연결된 행 조회 (콤마 구분)
no
createdAtAfter
해당 날짜 이후 생성된 행 조회 (date)
no
createdAtBefore
해당 날짜 이전 생성된 행 조회 (date)
no
updatedAtAfter
해당 날짜 이후 변경된 행 조회 (date, 증분 동기화용)
no
updatedAtBefore
해당 날짜 이전 변경된 행 조회 (date)
no
slugColumnKeys
검색할 컬럼의 slug 목록 (콤마 구분)
no
slugColumnValues
검색할 컬럼별 값 목록 (콤마 구분). slugColumnKeys가 있으면 필수, 개수 일치
no
Response
목록은 생성일 내림차순으로 정렬됩니다.
users,customers,deals는 테이블 설정(option)에서 사용하는 항목만 값이 채워지고, 사용하지 않는 항목은 빈 배열입니다.히스토리 기능을 사용하는 테이블은 현재 값만 반환됩니다.
Error Codes
400
SLUG_COLUMN_KEYS_AND_VALUES_MISMATCH
slugColumnKeys 값과 slugColumnValues 값의 개수가 다른 경우
403
CUSTOM_TABLE_ACCESS_DENIED
연결된 멤버에게 테이블 조회 권한이 없는 경우
404
NOT_FOUND_CUSTOM_TABLE
slug 또는 uuid에 해당하는 테이블이 없는 경우
404
NOT_FOUND_CUSTOM_COLUMN
slugColumnKeys에 존재하지 않는 컬럼 slug가 포함된 경우
Last updated