프로
엔터프라이즈
1000회/분

이메일 목록 조회

워크스페이스에 생성된 이메일 목록을 조회합니다.

Query Parameters
  • tagIds
    Type: integer Format: int
  • listId
    Type: integer Format: int
  • offset
    Type: integer Format: int
    min:  
    0
  • limit
    Type: integer Format: int
    min:  
    1
    max:  
    100

    한 번에 가져올 데이터의 최대 개수 (최대 100)

  • emailId
    Type: integer Format: int

    특정 이메일 아이디로 필터링

  • statuses
    Type: string

    조회할 이메일 상태(쉼표로 구분). 예) "0,3" 또는 "WRITING,SENT"

    • 상태 코드(숫자)와 상태 이름(statusName) 중 어느 쪽으로도 요청할 수 있습니다.

    • 상태 이름은 대소문자를 구분하지 않습니다. 예) "writing,sent"

    • 토큰 앞뒤 공백은 허용됩니다. 예) "0, 3"

    • 이름도 숫자도 아닌 값은 무시됩니다. 이 경우 400 오류는 발생하지 않습니다.

    • 위 목록에 없는 숫자도 무시되지 않고 조회 조건에 그대로 사용됩니다.

    • 0 (WRITING): 작성 중

    • 1 (RESERVED): 예약

    • 3 (SENT): 발송 완료

    • 10 (AUTO_DRAFT): 자동 작성 중

    • 11 (AUTO_SENDING): 자동 발송 중

    • 12 (AUTO_PAUSED): 자동 일시중지

    • 13 (AUTO_STOPPED): 자동 중지

    • 15 (AUTO_RESERVED): 자동 예약

    • 21 (PROCESSING): 처리 중

    • 22 (SENDING): 발송 중

    • 23 (SENDING_DELAYED): 발송 지연

    • 41 (FAILED): 실패

    • 42 (SPAM): 스팸

    ※ 21·22·23은 발송이 진행되는 동안 잠깐 거치는 상태입니다. 같은 조건으로 다시 조회하면 이미 다음 상태(예: 3 발송 완료)로 넘어가 목록에서 빠질 수 있습니다.

  • types
    Type: string

    조회할 이메일 종류(쉼표로 구분). 예) "1,2" 또는 "NORMAL,AB_TEST"

    • 종류 코드(숫자)와 종류 이름(typeName) 중 어느 쪽으로도 요청할 수 있습니다.

    • 종류 이름은 대소문자를 구분하지 않습니다. 예) "normal,ab_test"

    • 토큰 앞뒤 공백은 허용됩니다. 예) "1, 2"

    • 이름도 숫자도 아닌 값은 무시됩니다. 이 경우 400 오류는 발생하지 않습니다.

    • 위 목록에 없는 숫자도 무시되지 않고 조회 조건에 그대로 사용됩니다.

    • 지정하지 않으면 모든 종류를 반환합니다.

    • 1 (NORMAL): 일반 이메일

    • 2 (AB_TEST): A/B 이메일

    • 3 (AUTO_MAIL): 자동 이메일

    • 4 (AUTO_SMS): 자동 문자

  • sortBy
    Type: string enum

    정렬 기준 필드.

    • createdTime: 생성일시

    • modifiedTime: 수정일시

    • sentTime: 발송일시

    • 대소문자를 구분하지 않으며 앞뒤 공백은 무시됩니다. 예) "SENTTIME"

    • 위 목록에 없는 값을 보내면 400 오류가 발생합니다.

    • sortBy 를 지정하고 sortOrder 를 생략하면 desc 로 정렬됩니다.

    • sortBy 를 생략하고 sortOrder 만 지정하면 createdTime 기준으로 정렬됩니다.

    • 둘 다 생략하면 정렬 순서를 보장하지 않습니다.

    values
    • createdTime
    • modifiedTime
    • sentTime
  • sortOrder
    Type: string enum

    정렬 순서. 기준 필드는 sortBy 로 지정합니다.

    • 대소문자를 구분하지 않습니다. 예) "DESC"
    • sortBy 를 지정하고 sortOrder 를 생략하면 desc 로 정렬됩니다.
    • asc 또는 desc 가 아닌 값을 보내면 400 오류가 발생합니다.
    values
    • asc
    • desc
Responses
  • application/json
  • application/json
Request Example for get/emails
curl https://api.stibee.com/v2/emails \
  --header 'AccessToken: YOUR_SECRET_TOKEN'
{
  "total": 1,
  "offset": 0,
  "limit": 20,
  "items": [
    {
      "id": 123456,
      "owner": "abcd1234-ab12-cd34-ef56-abcdef123456",
      "status": 3,
      "statusName": "SENT",
      "type": 1,
      "typeName": "NORMAL",
      "listId": 1234,
      "subject": "이메일 제목",
      "senderEmail": "gildong.go@stibee.com",
      "senderName": "고길동",
      "permanentLink": "https://stib.ee/2eYF",
      "segmentIds": [
        1234
      ],
      "groupIds": null,
      "sentTime": "2024-07-23T18:43:03+09:00",
      "createdTime": "2024-07-19T17:56:06+09:00"
    }
  ]
}