프로
엔터프라이즈
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"

    • 0: 작성 중
    • 1: 예약
    • 3: 발송 완료
    • 10: 자동 작성 중
    • 11: 자동 발송 중
    • 12: 자동 일시중지
    • 13: 자동 중지
    • 15: 자동 예약
    • 21: 처리 중
    • 22: 발송 중
    • 23: 발송 지연
    • 41: 실패
    • 42: 스팸

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

  • sortOrder
    Type: string enum

    생성일시(createdTime) 기준 정렬 순서

    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": 8,
  "offset": 0,
  "limit": 8,
  "items": [
    {
      "id": 123456,
      "status": 3,
      "listId": 123456,
      "subject": "이메일 제목",
      "permanentLink": "https://stib.ee/2eYF",
      "segmentIds": [
        1234
      ],
      "groupIds": null,
      "sentTime": "2024-07-23T18:43:03+09:00",
      "senderEmail": "gildong.go@stibee.com",
      "senderName": "Gildong",
      "owner": "abcd1234-ab12-cd34-ef56-abcdef123456",
      "createdTime": "2024-07-19T17:56:06+09:00"
    }
  ]
}

이메일 목록 조회 성공